Show:

CGSGTimeline Class

Defined in: src\animation\class.anim.timeline.js:31
Module: Animation

Methods

_computeStepsValues () private

Defined in src\animation\class.anim.timeline.js:152

Compute the number of steps between all keys, 2 by 2

addKey
(
  • frame.
  • value
)
public

Defined in src\animation\class.anim.timeline.js:101

Add a new animation key frame to the timeline and sort the timeline by frame number

Parameters:
computeValue
(
  • keyIndex
  • frame
  • method
)
private

Defined in src\animation\class.anim.timeline.js:217

Compute animated value for one frame between key ay index keyIndex and keyIndex+1

Parameters:
  • keyIndex Number

    Must be an integer value.

  • frame Number

    Must be an integer value.

  • method String

    = "linear"

Returns:
: Object with 2 properties : frame and value, or undefined if keyIndex < 0
computeValues
(
  • fromFrame
  • method
)
public

Defined in src\animation\class.anim.timeline.js:187

Compute all the values (steps) for the animation of this timeline

Parameters:
  • fromFrame Number

    first frame at which one the computing must start. Must be an integer value.

  • method String

    interpolation method : "linear" for this timeline instance

exportValues () Array

Defined in src\animation\class.anim.timeline.js:333

Return the precomputed array of values for this timeline

Returns:
Array:
getFirstKey () CGSGAnimationKey

Defined in src\animation\class.anim.timeline.js:248

Returns:
CGSGAnimationKey: the first key frame of this timeline
getLastKey () CGSGAnimationKey

Defined in src\animation\class.anim.timeline.js:260

Returns:
CGSGAnimationKey: the last key frame of this timeline
getNbKeys () Number public

Defined in src\animation\class.anim.timeline.js:167

Returns:
Number: the number of keys in this timeline. Must be an integer value.
getValue
(
  • frame
)
Number public

Defined in src\animation\class.anim.timeline.js:272

Get the value for the frame number passed in parameter

Parameters:
  • frame Number

    the frame bound with the returned value. Must be an integer value.

Returns:
Number: the interpolated value of the attribute at the specified frame If no key is defined, return undefined If there is only one key, return it's value If the frame is before the first key, return the first key value If the frame is after the last key, return the last key value
importValues
(
  • newValues
  • startFrame
)

Defined in src\animation\class.anim.timeline.js:350

Import new precomputed values for this timeline. The number of values must match the number of frame defined by the keys of this timeline

Parameters:
  • newValues Array

    of new values

  • startFrame Number

    Must be an integer value.

removeAll () public

Defined in src\animation\class.anim.timeline.js:141

Remove all keys and values

removeKey
(
  • frame
)

Defined in src\animation\class.anim.timeline.js:119

Remove the key at the specified frame

Parameters:
  • frame Number

    Must be an integer value.

sortByFrame () public

Defined in src\animation\class.anim.timeline.js:176

Sort the list of keys by frame number

Properties

attribute String

Defined in src\animation\class.anim.timeline.js:53

A string representing the attribute to be animated (eg: "position.x", "rotation.angle", "fill", ...)

listValues Array

Defined in src\animation\class.anim.timeline.js:66

list of the [frame, value] pairs for the animation the index of the list begins at 0, not at the first key frame

onAnimate Function

Defined in src\animation\class.anim.timeline.js:93

Callback on animation event

onAnimationEnd Function

Defined in src\animation\class.anim.timeline.js:87

Callback on animation end event

onAnimationStart Function

Defined in src\animation\class.anim.timeline.js:81

Callback on animation start event

parentNode CGSGNode

Defined in src\animation\class.anim.timeline.js:46

The animated nodes